home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 April: Mac OS SDK / Dev.CD Apr 96 SDK / Dev.CD Apr 96 SDK1.toast / Development Kits (Disc 1) / OpenDoc / Documentation / Tech Notes & Articles / Recipes / Documents / Insert... Menuitem Recipe next >
Encoding:
Text File  |  1995-04-21  |  3.6 KB  |  177 lines  |  [TEXT/ttxt]
  1. OpenDoc™ Recipes
  2.  
  3.  
  4. Insert... Menuitem Recipe
  5. By The OpenDoc Design Team
  6. April 20th, 1995
  7.  
  8.  
  9. © 1993-1995  Apple Computer, Inc. All Rights Reserved.
  10. Apple, the Apple logo, and Macintosh are registered trademarks of Apple Computer, Inc.
  11. Mac and OpenDoc are trademarks of Apple Computer, Inc. 
  12.  
  13.  
  14.  
  15. Introduction
  16.  
  17. The fourth item in the OpenDoc “Document” menu is “Insert…” which a user chooses if they want to insert a part from a disk using the Standard File interface.  This recipes serves as sample code to do this. 
  18.  
  19. Caveats
  20.  
  21. • This code does NOT replicate the code for Cloning and Embedding.  Please see the Clipboard recipe for that code.
  22.  
  23. • It does not contain proper error checking
  24.  
  25. • It does not account for the case where a part may want to Insert… a file which is not an OpenDoc part.
  26.  
  27. • It does not properly filter out files which are not ODContainers
  28.  
  29. • Instead of kODDefaultFileContainer, it should use  file->GetContainerType()    
  30.  
  31. • It uses the PlatformFile class which is an unsupported private utility class of OpenDoc
  32.  
  33. • It always embeds the inserted part, whereas some part editors may want to incorporate inserted content.
  34.  
  35. Sample Code
  36.  
  37. #include "ODSessn.xh"
  38.  
  39. #include "WinStat.xh"
  40.  
  41. #include "PlfmFile.h"
  42.  
  43. #include "Storage.h"
  44.  
  45. #include "ODCtr.xh"
  46.  
  47. #include "Document.xh"
  48.  
  49. #include "Draft.xh"
  50.  
  51. #include "StorageU.xh"
  52.  
  53.  
  54. …
  55.  
  56.  
  57. void CMyPart::Insert(Environment* ev)
  58. {
  59.  
  60.     StandardFileReply sfReply;
  61.  
  62.     SFTypeList sfTypes;
  63.  
  64.     ODStorageUnit* mySU = this->GetStorageUnit(ev);
  65.  
  66.     ODDraft* myDraft = mySU->GetDraft(ev);
  67.  
  68.     ODSession* session = mySU->GetSession(ev);
  69.  
  70.     ODWindowState* windowState = session->GetWindowState(ev);
  71.  
  72.     ODContainer* insertContainer = kODNULL;
  73.  
  74.     
  75.     // Prompt the User to Insert… a file
  76.  
  77.     windowState->DeactivateFrontWindows(ev);
  78.  
  79.     StandardGetFile((FileFilterUPP)kODNULL,-1,sfTypes,&sfReply);
  80.  
  81.     windowState->ActivateFrontWindows(ev);
  82.  
  83.     
  84.     // If the user selected a file and clicked 'OK'
  85.  
  86.     if (sfReply.sfGood) 
  87.  
  88.     {
  89.  
  90.         ODFile* file = new ODFile();
  91.  
  92.         file->Specify(&(sfReply.sfFile));
  93.  
  94.         
  95.         TRY
  96.  
  97.             insertContainer = session->GetStorageSystem(ev)->
  98.  
  99.                 GetContainer(ev,kODDefaultFileContainer,file);
  100.  
  101.             // $$$$$ will become: file->GetContainerType(); //tç
  102.  
  103.         CATCH_ALL
  104.  
  105.             insertContainer = kODNULL;
  106.  
  107.         ENDTRY
  108.  
  109.     
  110.         // If the user chose an OpenDoc ODContainer
  111.  
  112.         if (insertContainer != kODNULL) 
  113.  
  114.         {
  115.  
  116.             ODDraft* nextDraft = kODNULL;
  117.  
  118.             ODDraft* insertDraft = kODNULL;
  119.  
  120.     
  121.             ODDocument* insertDocument =
  122.  
  123.                                         insertContainer->GetDocument(ev, kODDefaultDocument);
  124.  
  125.             insertDraft = insertDocument->GetBaseDraft(ev, kDPReadOnly);
  126.  
  127.             while (insertDocument->Exists(ev,0,insertDraft,kODPosLastAbove))
  128.  
  129.                                         insertDraft = aDocument->GetDraft(ev, kDPReadOnly,
  130.  
  131.                                                                  kODNULL, insertDraft, kODPosLastAbove,kODTrue);
  132.  
  133.             ODStorageUnitRef                suref;
  134.  
  135.             ODStorageUnit* draftSU = insertDraft->GetDraftProperties(ev);
  136.  
  137.             draftSU->Focus(ev, kODPropRootPartSU, kODPosUndefined,
  138.  
  139.                                                                     kODStorageUnit, 0, kODPosUndefined);
  140.  
  141.             draftSU->GetValue(ev, sizeof(ODStorageUnitRef), &suRef);
  142.  
  143.             ODStorageUnit* insertSU = insertDraft->GetStorageUnit(ev, 
  144.  
  145.                     draftSU->GetIDFromStorageUnitRef(ev, suRef));
  146.  
  147.     
  148.             // Clone the root part from the insertDraft to this draft.
  149.  
  150.             // This is identical to pasting a part from the Clipboard
  151.  
  152.             // Please refer to the Clipboard recipe to implement the
  153.  
  154.             // ClonePartAndEmbed function.
  155.  
  156.             this->ClonePartAndEmbed(ev, insertSU);
  157.  
  158.  
  159.             // Important: you must perform the following Release() calls
  160.  
  161.             // in the exact order they are listed.
  162.  
  163.             insertSU->Release(ev);
  164.  
  165.             insertDraft->Release(ev);
  166.  
  167.             insertDocument->Release(ev);
  168.  
  169.             insertContainer->Release(ev);
  170.  
  171.         }
  172.  
  173.         delete file;
  174.  
  175.     }
  176.  
  177. }